<!--

     Licensed to the Apache Software Foundation (ASF) under one
     or more contributor license agreements.  See the NOTICE file
     distributed with this work for additional information
     regarding copyright ownership.  The ASF licenses this file
     to you under the Apache License, Version 2.0 (the
     "License"); you may not use this file except in compliance
     with the License.  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

     Unless required by applicable law or agreed to in writing,
     software distributed under the License is distributed on an
     "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
     KIND, either express or implied.  See the License for the
     specific language governing permissions and limitations
     under the License.

-->
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- **************************************************************** -->
<!-- *  PLEASE KEEP COMPLICATED EXPRESSIONS OUT OF THESE TEMPLATES, * -->
<!-- *  i.e. only iterate & print data where possible. Thanks, Jez. * -->
<!-- **************************************************************** -->

<html>
<head>
    <!-- Generated by groovydoc (2.4.7) on Thu Dec 01 22:36:10 PST 2016 -->
    <title>CacheFacade (Moqui Framework 2.0.0)</title>
    <meta name="date" content="2016-12-01">
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    <link href="../../../groovy.ico" type="image/x-icon" rel="shortcut icon">
    <link href="../../../groovy.ico" type="image/x-icon" rel="icon">
    <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">

<body class="center">
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
    parent.document.title="CacheFacade (Moqui Framework 2.0.0)";
}
//-->
</script>
<noscript>
    <div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
    <!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
    <!--   -->
</a>
    <ul class="navList" title="Navigation">
        <li><a href="../../../overview-summary.html">Overview</a></li>
        <li><a href="package-summary.html">Package</a></li>
        <li class="navBarCell1Rev">Class</li>
        <li><a href="../../../deprecated-list.html">Deprecated</a></li>
        <li><a href="../../../index-all.html">Index</a></li>
        <li><a href="../../../help-doc.html">Help</a></li>
    </ul>
</div>

<div class="subNav">
    <div>
        <ul class="navList">
            <li><a href="../../../index.html?org/moqui/context/CacheFacade" target="_top">Frames</a></li>
            <li><a href="CacheFacade.html" target="_top">No Frames</a></li>
        </ul>
    </div>
    <div>
        <ul class="subNavList">
            <li>Summary:&nbsp;</li>
            Nested&nbsp;&nbsp;&nbsp;Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<li><a href="#method_summary">Method</a></li>&nbsp;&nbsp;&nbsp;
        </ul>
        <ul class="subNavList">
            <li>&nbsp;|&nbsp;Detail:&nbsp;</li>
            Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<li><a href="#method_detail">Method</a></li>&nbsp;&nbsp;&nbsp;
        </ul>
    </div>
    <a name="skip-navbar_top">
        <!--   -->
    </a></div>
<!-- ========= END OF TOP NAVBAR ========= -->

<!-- ======== START OF CLASS DATA ======== -->
<div class="header">

    <div class="subTitle">Package: <strong>org.moqui.context</strong></div>

    <h2 title="[Java] Interface CacheFacade" class="title">[Java] Interface CacheFacade</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">

</ul>
<div class="description">
    <ul class="blockList">
        <li class="blockList">


    <p> A facade used for managing and accessing Cache instances. </p>

          </li>
    </ul>
</div>

<div class="summary">
    <ul class="blockList">
        <li class="blockList">
        <!-- =========== NESTED CLASS SUMMARY =========== -->
        

        <!-- =========== ENUM CONSTANT SUMMARY =========== -->
        
        <!-- =========== FIELD SUMMARY =========== -->
        

        <!-- =========== PROPERTY SUMMARY =========== -->
        

        <!-- =========== ELEMENT SUMMARY =========== -->
        

        

        
        <!-- ========== METHOD SUMMARY =========== -->
        <ul class="blockList">
            
            <li class="blockList"><a name="method_summary"><!--   --></a>
                    <h3>Methods Summary</h3>
                    <ul class="blockList">
                    <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Methods Summary table">
                        <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
                        <tr>
                            <th class="colFirst" scope="col">Type</th>
                            <th class="colLast" scope="col">Name and description</th>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code>boolean</strong></code></td>
                            <td class="colLast"><code><strong><a href="#cacheExists(java.lang.String)">cacheExists</a></strong>(java.lang.String cacheName)</code><br></td>
                        </tr>
                        
                        <tr class="rowColor">
                            <td class="colFirst"><code>void</strong></code></td>
                            <td class="colLast"><code><strong><a href="#clearAllCaches()">clearAllCaches</a></strong>()</code><br></td>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code>void</strong></code></td>
                            <td class="colLast"><code><strong><a href="#clearCachesByPrefix(java.lang.String)">clearCachesByPrefix</a></strong>(java.lang.String prefix)</code><br></td>
                        </tr>
                        
                        <tr class="rowColor">
                            <td class="colFirst"><code>javax.cache.Cache</strong></code></td>
                            <td class="colLast"><code><strong><a href="#getCache(java.lang.String)">getCache</a></strong>(java.lang.String cacheName)</code><br>Get the named Cache, creating one based on configuration and defaults if none exists.
 </td>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code>javax.cache.Cache&lt;K, V&gt;</strong></code></td>
                            <td class="colLast"><code><strong><a href="#getCache(java.lang.String, Class<K>, Class<V>)">getCache</a></strong>(java.lang.String cacheName, java.lang.Class&lt;K&gt; keyType, java.lang.Class&lt;V&gt; valueType)</code><br>A type-safe variation on getCache for configured caches.</td>
                        </tr>
                        
                        <tr class="rowColor">
                            <td class="colFirst"><code>java.util.Set&lt;java.lang.String&gt;</strong></code></td>
                            <td class="colLast"><code><strong><a href="#getCacheNames()">getCacheNames</a></strong>()</code><br></td>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code>javax.cache.Cache</strong></code></td>
                            <td class="colLast"><code><strong><a href="#getDistributedCache(java.lang.String)">getDistributedCache</a></strong>(java.lang.String cacheName)</code><br>Get the named distributed Cache, creating one based on configuration and defaults if none exists.
 </td>
                        </tr>
                        
                        <tr class="rowColor">
                            <td class="colFirst"><code>org.moqui.jcache.MCache</strong></code></td>
                            <td class="colLast"><code><strong><a href="#getLocalCache(java.lang.String)">getLocalCache</a></strong>(java.lang.String cacheName)</code><br>Get the named local Cache (MCache instance), creating one based on defaults if none exists.
 </td>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code>void</strong></code></td>
                            <td class="colLast"><code><strong><a href="#registerCache(javax.cache.Cache)">registerCache</a></strong>(javax.cache.Cache cache)</code><br>Register an externally created cache for future gets, inclusion in cache management tools, etc.
 </td>
                        </tr>
                        
                    </table>
                   </ul>
              </li>
            
        </ul>
        
    </li>
    </ul>
</div>

<div class="details">
    <ul class="blockList">
        <li class="blockList">
           

            

            

            

            


            
            <!-- =========== METHOD DETAIL =========== -->
            <ul class="blockList">
                <li class="blockList"><a name="method_detail">
                    <!--   -->
                </a>
                    <h3>Method Detail</h3>
                    
                        <a name="cacheExists(java.lang.String)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>public&nbsp;boolean <strong>cacheExists</strong>(java.lang.String cacheName)</h4>
                                <p></p>
                            </li>
                        </ul>
                    
                        <a name="clearAllCaches()"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>public&nbsp;void <strong>clearAllCaches</strong>()</h4>
                                <p></p>
                            </li>
                        </ul>
                    
                        <a name="clearCachesByPrefix(java.lang.String)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>public&nbsp;void <strong>clearCachesByPrefix</strong>(java.lang.String prefix)</h4>
                                <p></p>
                            </li>
                        </ul>
                    
                        <a name="getCache(java.lang.String)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>public&nbsp;javax.cache.Cache <strong>getCache</strong>(java.lang.String cacheName)</h4>
                                <p> Get the named Cache, creating one based on configuration and defaults if none exists.
 Defaults to local cache if no configuration found. </p>
                            </li>
                        </ul>
                    
                        <a name="getCache(java.lang.String, Class<K>, Class<V>)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>public&nbsp;javax.cache.Cache&lt;K, V&gt; <strong>getCache</strong>(java.lang.String cacheName, java.lang.Class&lt;K&gt; keyType, java.lang.Class&lt;V&gt; valueType)</h4>
                                <p> A type-safe variation on getCache for configured caches. </p>
                            </li>
                        </ul>
                    
                        <a name="getCacheNames()"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>public&nbsp;java.util.Set&lt;java.lang.String&gt; <strong>getCacheNames</strong>()</h4>
                                <p></p>
                            </li>
                        </ul>
                    
                        <a name="getDistributedCache(java.lang.String)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>public&nbsp;javax.cache.Cache <strong>getDistributedCache</strong>(java.lang.String cacheName)</h4>
                                <p> Get the named distributed Cache, creating one based on configuration and defaults if none exists.
 If the cache is configured without type != 'distributed' this will return an error. </p>
                            </li>
                        </ul>
                    
                        <a name="getLocalCache(java.lang.String)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>public&nbsp;org.moqui.jcache.MCache <strong>getLocalCache</strong>(java.lang.String cacheName)</h4>
                                <p> Get the named local Cache (MCache instance), creating one based on defaults if none exists.
 If the cache is configured with type != 'local' this will return an error. </p>
                            </li>
                        </ul>
                    
                        <a name="registerCache(javax.cache.Cache)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>public&nbsp;void <strong>registerCache</strong>(javax.cache.Cache cache)</h4>
                                <p> Register an externally created cache for future gets, inclusion in cache management tools, etc.
 If a cache with the same name exists the call will be ignored (ie like putIfAbsent). </p>
                            </li>
                        </ul>
                    
                </li>
            </ul>
            
        </li>
    </ul>
</div>

<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
    <!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
    <!--   -->
</a>
    <ul class="navList" title="Navigation">
        <li><a href="../../../overview-summary.html">Overview</a></li>
        <li><a href="package-summary.html">Package</a></li>
        <li class="navBarCell1Rev">Class</li>
        <li><a href="../../../deprecated-list.html">Deprecated</a></li>
        <li><a href="../../../index-all.html">Index</a></li>
        <li><a href="../../../help-doc.html">Help</a></li>
    </ul>
</div>

<div class="subNav">
    <div>
        <ul class="navList">
            <li><a href="../../../index.html?org/moqui/context/CacheFacade" target="_top">Frames</a></li>
            <li><a href="CacheFacade.html" target="_top">No Frames</a></li>
        </ul>
    </div>
    <div>
        <ul class="subNavList">
            <li>Summary:&nbsp;</li>
            Nested&nbsp;&nbsp;&nbsp;Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<li><a href="#method_summary">Method</a></li>&nbsp;&nbsp;&nbsp;
        </ul>
        <ul class="subNavList">
            <li>&nbsp;|&nbsp;Detail:&nbsp;</li>
            Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<li><a href="#method_detail">Method</a></li>&nbsp;&nbsp;&nbsp;
        </ul>
    </div>
    <p>Groovy Documentation</p>
    <a name="skip-navbar_bottom">
        <!--   -->
    </a>
    </div>
</div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
